Skip to content

Migrate GitHub wiki content to Docs/ folder#1659

Open
angularsen wants to merge 1 commit intomasterfrom
agl/wiki-to-docs
Open

Migrate GitHub wiki content to Docs/ folder#1659
angularsen wants to merge 1 commit intomasterfrom
agl/wiki-to-docs

Conversation

@angularsen
Copy link
Copy Markdown
Owner

@angularsen angularsen commented May 1, 2026

Consolidate 16 wiki pages into Docs/ as the single source of truth, deduplicating content previously split across the wiki, CONTRIBUTING.md, and .claude/.

The motivation is to make docs easier to maintain with AI agents.
The key benefit of wiki is to more easily accept contributions and automatic menu navigation per page, but contributions have historically been zero and AI makes it much more efficient to manage docs.

The idea is to preserve wiki pages for a while, but link replace their content with links to these files instead.

New Docs/ structure:

  • adding-a-new-unit.md, adding-operator-overloads.md, precision.md
  • string-formatting.md, serialization.md, saving-to-database.md
  • extending-with-custom-units.md, experimental-generic-math.md, nanoframework.md
  • upgrading-from-{3,4,5}.x-to-{4,5,6}.x.md
  • collaborators/{issues-and-pull-requests,releasing-nugets,regenerate-nuget-api-key}.md
  • README.md (index)

Other changes:

  • Fix backwards convention in conversion functions: prefer * for FromUnitToBaseFunc and / for FromBaseToUnitFunc (wiki had it reversed).
  • Merge two overlapping NuGet release wiki pages into releasing-nugets.md.
  • Skip Changelog wiki page (GitHub Releases is canonical) and Home (placeholder).
  • CONTRIBUTING.md: slim down, link to Docs/ for detailed conversion/abbreviation rules.
  • CLAUDE.md: add Documentation section linking to Docs/, reference adding-a-new-unit.md for conversion guidelines.
  • .claude/criteria-for-adding-quantities-and-units.md: reference Docs/ instead of wiki.

Consolidate 16 wiki pages into Docs/ as the single source of truth, deduplicating
content previously split across the wiki, CONTRIBUTING.md, and .claude/.

New Docs/ structure:
- adding-a-new-unit.md, adding-operator-overloads.md, precision.md
- string-formatting.md, serialization.md, saving-to-database.md
- extending-with-custom-units.md, experimental-generic-math.md, nanoframework.md
- upgrading-from-{3,4,5}.x-to-{4,5,6}.x.md
- collaborators/{issues-and-pull-requests,releasing-nugets,regenerate-nuget-api-key}.md
- README.md (index)

Other changes:
- Fix backwards convention in conversion functions: prefer * for FromUnitToBaseFunc
  and / for FromBaseToUnitFunc (wiki had it reversed).
- Merge two overlapping NuGet release wiki pages into releasing-nugets.md.
- Skip Changelog wiki page (GitHub Releases is canonical) and Home (placeholder).
- CONTRIBUTING.md: slim down, link to Docs/ for detailed conversion/abbreviation rules.
- CLAUDE.md: add Documentation section linking to Docs/, reference adding-a-new-unit.md
  for conversion guidelines.
- .claude/criteria-for-adding-quantities-and-units.md: reference Docs/ instead of wiki.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude Bot commented May 2, 2026

PR Review: Migrate GitHub wiki content to Docs/ folder

Overview: Consolidates 16 wiki pages into Docs/ as the canonical documentation source to improve maintainability with AI agents. Good motivation and solid execution.

Positive

  • Centralizing docs in-repo makes AI-assisted maintenance much more effective
  • The new Docs/ structure is well-organized with a clear README index
  • Fixing the backwards conversion convention note (wiki had *// reversed) is a good catch
  • Slimming down CONTRIBUTING.md to link out rather than duplicate is cleaner

Minor Concerns

CONTRIBUTING.md loses actionable content without replacing it:
The PR removes the conversion function rules and unit abbreviation rules from CONTRIBUTING.md in favor of a link to Docs/adding-a-new-unit.md. That's fine, but the link target is #1-add-or-modify-json-file-for-a-quantity-class — make sure that anchor actually exists in Docs/adding-a-new-unit.md once the PR lands.

CLAUDE.md bullet drift:
The new CLAUDE.md bullet — "Use exact constituent constants instead of pre-computed decimals" — is a good addition. Worth double-checking it's also reflected in Docs/adding-a-new-unit.md so there's no drift between the two files describing the same rule.

Overall: Ready to merge. Clean documentation consolidation with no functional impact.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant